package com.liusy.serachengine.demo;

public interface WebSearch extends Search {

	/**
	 * 此方法用于限制由此搜索器返回的网络搜索结果集。要限制为 www.amazon.com，只需通过传递一个“www.amazon.com”值调用此方法。
	 * 要清除网站限制，请传递值 null。以下代码段演示了将集的设置限制为“amazon.com”。可以在网站限制示例上找到更完整的示例。
	 * var siteSearch = new g.search.WebSearch();  
	 * siteSearch.setSiteRestriction("amazon.com");
	 * 
	 * 此方法还允许调用程序将搜索限制为 Google 自定义搜索引擎。传递自定义搜索引擎 ID，而不是指定此方法的网址路径。
	 * 通过 自定义搜索，您可以借助Server 的强大功能实现适合自己网站的自定义搜索功能。
 	 * ①加入一个或多个网站或者特定网页 
	 * ②将搜索框和搜索结果放入您自己的网站 
	 * ③自定义搜索结果的外观，使之符合您网站的风格  
	 * 以下代码段演示了将网站限制设置为一个自定义搜索引擎（其 ID 为 000455696194071821846:reviews）。可以在自定义搜索引擎示例上找到更完整的示例。 
	 * var siteSearch = new g.search.WebSearch();  
	 * siteSearch.setSiteRestriction("000455696194071821846:reviews");  
	 * 
	 * 以此方式使用时，可以通过使用 来提供一个可选的自定义搜索引擎改进opt_refinement。
	 * 使用此机制，您能够将网站限制为搜索引擎的子集。
	 * 在 opt_refinement 中指定的值必须匹配与指定的搜索引擎相关联的“自定义搜索引擎改进”标签（请参见以下代码段）。可以在课程搜索示例上找到更完整的示例。 
	 * var cseId = "017576662512468239146:omuauf_lfve";  
	 * var siteSearch = new g.search.WebSearch();  
	 * siteSearch.setSiteRestriction(cseId, "Lectures");                  
	 *  
	 * 自定义搜索引擎通常包括一个自定义的搜索结果登录页面。
	 * 为了支持此页面，当自定义搜索引擎网站限制有效时，可能会提供一个可选的 opt_moreResultsTemplate 值。
	 * 这将指定一个网址模板，该模板将用于在一组搜索结果的底部生成“更多结果”链接。
	 * 该网址模板必须包括一个“__QUERY__”和“__HL__”占位符。
	 * 当生成“更多结果”链接时，系统将使用当前查询条目和 UI 语言来替换这些占位符。
	 * 此示例演示了如何将此机制用于主标签、左侧标签：课程搜索示例。 
	 * 自定义搜索引擎的最后一项改进是可以使用链接的自定义搜索引擎。
	 * 为了支持此功能，已将 site 参数扩展，以便其除了指定网站限制的新匿名对象模式之外，还可以支持以上列出的所有选项和模式。
	 * 当 site 参数是一个对象时，可能存在以下属性之一（以优先级顺序列出，这意味着如果您提供了多个属性，将获得我们测试的第一个属性 [按以下列出的顺序]）： 
	 * 
	 * siteUrl - 搜索与提供的网址相关 
	 * cseId - 搜索与提供的自定义搜索引擎 ID 相关（例如，000455696194071821846:reviews） 
	 * crefUrl - 搜索与由提供的网址指向的链接自定义搜索引擎相关。有关详细信息，请参见此示例。 
	 * 
	 * 当指定了 cseId 或 crefUrl 时，可以通过使用 来提供一个可选的自定义搜索引擎改进opt_refinement。
	 * 使用此机制，您能够将网站限制为搜索引擎的子集。
	 * 在 opt_refinement 中指定的值必须匹配与指定的搜索引擎相关联的“自定义搜索引擎改进”标签（请参见以下代码段）。
	 * searcher = new g.search.WebSearch();  
	 * searcher.setSiteRestriction({crefUrl : "http://www.google.com/cse/samples/vegetarian.xml"},"recipes");                  
	 *  
	 * @param site 网站 - 以部分网址的形式（例如，“www.amazon.com”、“google.com”等）或自定义搜索引擎 ID（例如，"000455696194071821846:reviews"、"000455696194071821846:shopping" 等）形式提供了网站限制设置。这还可以包含如上所述的匿名对象。 
	 * @param opt_refinement - 当 site 指的是自定义搜索引擎时，该可选参数的值将指定自定义搜索引擎改进 
	 * @param opt_moreResultsTemplate - 当 site 指的是自定义搜索引擎时，该可选参数的值将指定一个网址模板，此模板将被用于建立“更多结果”链接（此链接将显示在搜索控件中的一组搜索结果下面）。该网址模板必须包括一个“__QUERY__”和“__HL__”占位符。当生成“更多结果”链接时，系统将使用当前查询条目和 UI 语言来替换这些占位符。 
	 */
	public void setSiteRestriction(String site, String opt_refinement, String opt_moreResultsTemplate);
	
	/**
	 * 此方法用于指定或清除由此搜索器返回的有关结果集的限制。为了建立限制，type 和 opt_value 均必须提供且有效。
	 * 为了清除限制，请为 type 提供一个有效值，或为 opt_value 的值指定 null，或者不提供此值。
	 * 该 API 当前支持一个由值 g.search.Search.RESTRICT_SAFESEARCH 表示的限制类型。
	 * 当此限制类型指定为 type 值时，提供g.search.Search.SAFESEARCH_STRICT 的 opt_value 会过滤搜索结果以排除露骨的文本和图片（请注意，这是默认操作）。
	 * 提供 opt_value. 的 g.search.Search.SAFESEARCH_MODERATE 时，将会过滤搜索结果以排除露骨的图片，并且最终 opt_value 的g.search.Search.SAFESEARCH_OFF 将导致未经过滤的结果。
	 * 以下代码段演示了如何关闭安全搜索过滤。 
	 * var searcher = new g.search.WebSearch();  
	 * searcher.setRestriction(g.search.Search.RESTRICT_SAFESEARCH,                         
	 * g.search.Search.SAFESEARCH_OFF);                  
	 * 
	 * @param type - 提供了要建立的限制的类型. 
	 * 当前，唯一有效的值是 g.search.Search.RESTRICT_SAFESEARCH，它被用于建立或清除一个类型限制。 
	 * @param opt_value - 为指定的限制类型提供值。如果值为空，将清除指定的限制。否则，与 type 值相关的值必须有效，在这种情况下，会建立一个限制。目前，用于限制类型的唯一有效值为： 
	 *                    g.search.Search.SAFESEARCH_STRICT - 对露骨的文本和图片均应用严格的过滤（默认操作） 
	 *                    g.search.Search.SAFESEARCH_MODERATE - 对露骨的图片应用过滤 
	 *                    g.search.Search.SAFESEARCH_OFF - 不应用安全搜索过滤  
	 */
	public void setRestriction(String type, String opt_value);

	
}
